Package pl.wendigo.chrome.api.network

Contains DevTools Protocol Network domain implementation accessible via NetworkDomain class.

Types

AuthChallenge

data class AuthChallenge(source: String?, origin: String, scheme: String, realm: String)

Authorization challenge for HTTP status code 401 or 407.

AuthChallengeResponse

data class AuthChallengeResponse(response: String, username: String?, password: String?)

Response to an AuthChallenge.

BlockedCookieWithReason

data class BlockedCookieWithReason(blockedReasons: List<CookieBlockedReason>, cookie: Cookie)

A cookie with was not sent with a request with the corresponding reason.

BlockedReason

enum BlockedReason : Enum<BlockedReason>

The reason why request was blocked.

BlockedSetCookieWithReason

data class BlockedSetCookieWithReason(blockedReasons: List<SetCookieBlockedReason>, cookieLine: String, cookie: Cookie?)

A cookie which was not stored from a response with the corresponding reason.

CachedResource

data class CachedResource(url: String, type: ResourceType, response: Response?, bodySize: Double)

Information about the cached resource.

CanClearBrowserCacheResponse

data class CanClearBrowserCacheResponse(result: Boolean)

Represents response frame that is returned from Network#canClearBrowserCache operation call.

CanClearBrowserCookiesResponse

data class CanClearBrowserCookiesResponse(result: Boolean)

Represents response frame that is returned from Network#canClearBrowserCookies operation call.

CanEmulateNetworkConditionsResponse

data class CanEmulateNetworkConditionsResponse(result: Boolean)

Represents response frame that is returned from Network#canEmulateNetworkConditions operation call.

CertificateTransparencyCompliance

enum CertificateTransparencyCompliance : Enum<CertificateTransparencyCompliance>

Whether the request complied with Certificate Transparency policy.

ClientSecurityState

data class ClientSecurityState(initiatorIsSecureContext: Boolean, initiatorIPAddressSpace: IPAddressSpace, privateNetworkRequestPolicy: PrivateNetworkRequestPolicy)

ConnectionType

enum ConnectionType : Enum<ConnectionType>

The underlying connection technology that the browser is supposedly using.

ContinueInterceptedRequestRequest

data class ContinueInterceptedRequestRequest(interceptionId: InterceptionId, errorReason: ErrorReason?, rawResponse: String?, url: String?, method: String?, postData: String?, headers: Headers?, authChallengeResponse: AuthChallengeResponse?)

Represents request frame that can be used with Network#continueInterceptedRequest operation call.

data class Cookie(name: String, value: String, domain: String, path: String, expires: Double, size: Int, httpOnly: Boolean, secure: Boolean, session: Boolean, sameSite: CookieSameSite?, priority: CookiePriority, sameParty: Boolean, sourceScheme: CookieSourceScheme, sourcePort: Int)

Cookie object

CookieBlockedReason

enum CookieBlockedReason : Enum<CookieBlockedReason>

Types of reasons why a cookie may not be sent with a request.

CookieParam

data class CookieParam(name: String, value: String, url: String?, domain: String?, path: String?, secure: Boolean?, httpOnly: Boolean?, sameSite: CookieSameSite?, expires: TimeSinceEpoch?, priority: CookiePriority?, sameParty: Boolean?, sourceScheme: CookieSourceScheme?, sourcePort: Int?)

Cookie parameter object

CookiePriority

enum CookiePriority : Enum<CookiePriority>

Represents the cookie's 'Priority' status: https://tools.ietf.

CookieSameSite

enum CookieSameSite : Enum<CookieSameSite>

Represents the cookie's 'SameSite' status: https://tools.ietf.

CookieSourceScheme

enum CookieSourceScheme : Enum<CookieSourceScheme>

Represents the source scheme of the origin that originally set the cookie.

CorsError

enum CorsError : Enum<CorsError>

The reason why request was blocked.

CorsErrorStatus

data class CorsErrorStatus(corsError: CorsError, failedParameter: String)

CrossOriginEmbedderPolicyStatus

data class CrossOriginEmbedderPolicyStatus(value: CrossOriginEmbedderPolicyValue, reportOnlyValue: CrossOriginEmbedderPolicyValue, reportingEndpoint: String?, reportOnlyReportingEndpoint: String?)

CrossOriginEmbedderPolicyValue

enum CrossOriginEmbedderPolicyValue : Enum<CrossOriginEmbedderPolicyValue>

CrossOriginOpenerPolicyStatus

data class CrossOriginOpenerPolicyStatus(value: CrossOriginOpenerPolicyValue, reportOnlyValue: CrossOriginOpenerPolicyValue, reportingEndpoint: String?, reportOnlyReportingEndpoint: String?)

CrossOriginOpenerPolicyValue

enum CrossOriginOpenerPolicyValue : Enum<CrossOriginOpenerPolicyValue>

DataReceivedEvent

data class DataReceivedEvent(requestId: RequestId, timestamp: MonotonicTime, dataLength: Int, encodedDataLength: Int) : Event

Fired when data chunk was received over the network.

DeleteCookiesRequest

data class DeleteCookiesRequest(name: String, url: String?, domain: String?, path: String?)

Represents request frame that can be used with Network#deleteCookies operation call.

EmulateNetworkConditionsRequest

data class EmulateNetworkConditionsRequest(offline: Boolean, latency: Double, downloadThroughput: Double, uploadThroughput: Double, connectionType: ConnectionType?)

Represents request frame that can be used with Network#emulateNetworkConditions operation call.

EnableRequest

data class EnableRequest(maxTotalBufferSize: Int?, maxResourceBufferSize: Int?, maxPostDataSize: Int?)

Represents request frame that can be used with Network#enable operation call.

ErrorReason

enum ErrorReason : Enum<ErrorReason>

Network level fetch failure reason.

EventSourceMessageReceivedEvent

data class EventSourceMessageReceivedEvent(requestId: RequestId, timestamp: MonotonicTime, eventName: String, eventId: String, data: String) : Event

Fired when EventSource message is received.

GetAllCookiesResponse

data class GetAllCookiesResponse(cookies: List<Cookie>)

Represents response frame that is returned from Network#getAllCookies operation call.

GetCertificateRequest

data class GetCertificateRequest(origin: String)

Represents request frame that can be used with Network#getCertificate operation call.

GetCertificateResponse

data class GetCertificateResponse(tableNames: List<String>)

Represents response frame that is returned from Network#getCertificate operation call.

GetCookiesRequest

data class GetCookiesRequest(urls: List<String>?)

Represents request frame that can be used with Network#getCookies operation call.

GetCookiesResponse

data class GetCookiesResponse(cookies: List<Cookie>)

Represents response frame that is returned from Network#getCookies operation call.

GetRequestPostDataRequest

data class GetRequestPostDataRequest(requestId: RequestId)

Represents request frame that can be used with Network#getRequestPostData operation call.

GetRequestPostDataResponse

data class GetRequestPostDataResponse(postData: String)

Represents response frame that is returned from Network#getRequestPostData operation call.

GetResponseBodyForInterceptionRequest

data class GetResponseBodyForInterceptionRequest(interceptionId: InterceptionId)

Represents request frame that can be used with Network#getResponseBodyForInterception operation call.

GetResponseBodyForInterceptionResponse

data class GetResponseBodyForInterceptionResponse(body: String, base64Encoded: Boolean)

Represents response frame that is returned from Network#getResponseBodyForInterception operation call.

GetResponseBodyRequest

data class GetResponseBodyRequest(requestId: RequestId)

Represents request frame that can be used with Network#getResponseBody operation call.

GetResponseBodyResponse

data class GetResponseBodyResponse(body: String, base64Encoded: Boolean)

Represents response frame that is returned from Network#getResponseBody operation call.

GetSecurityIsolationStatusRequest

data class GetSecurityIsolationStatusRequest(frameId: FrameId?)

Represents request frame that can be used with Network#getSecurityIsolationStatus operation call.

GetSecurityIsolationStatusResponse

data class GetSecurityIsolationStatusResponse(status: SecurityIsolationStatus)

Represents response frame that is returned from Network#getSecurityIsolationStatus operation call.

Headers

typealias Headers = Map<String, JsonElement>

Request / response headers as keys / values of JSON object.

Initiator

data class Initiator(type: String, stack: StackTrace?, url: String?, lineNumber: Double?, columnNumber: Double?, requestId: RequestId?)

Information about the request initiator.

InterceptionId

typealias InterceptionId = String

Unique intercepted request identifier.

InterceptionStage

enum InterceptionStage : Enum<InterceptionStage>

Stages of the interception to begin intercepting.

IPAddressSpace

enum IPAddressSpace : Enum<IPAddressSpace>

LoaderId

typealias LoaderId = String

Unique loader identifier.

LoadingFailedEvent

data class LoadingFailedEvent(requestId: RequestId, timestamp: MonotonicTime, type: ResourceType, errorText: String, canceled: Boolean?, blockedReason: BlockedReason?, corsErrorStatus: CorsErrorStatus?) : Event

Fired when HTTP request has failed to load.

LoadingFinishedEvent

data class LoadingFinishedEvent(requestId: RequestId, timestamp: MonotonicTime, encodedDataLength: Double, shouldReportCorbBlocking: Boolean?) : Event

Fired when HTTP request has finished loading.

LoadNetworkResourceOptions

data class LoadNetworkResourceOptions(disableCache: Boolean, includeCredentials: Boolean)

An options object that may be extended later to better support CORS, CORB and streaming.

LoadNetworkResourcePageResult

data class LoadNetworkResourcePageResult(success: Boolean, netError: Double?, netErrorName: String?, httpStatusCode: Double?, stream: StreamHandle?, headers: Headers?)

An object providing the result of a network resource load.

LoadNetworkResourceRequest

data class LoadNetworkResourceRequest(frameId: FrameId, url: String, options: LoadNetworkResourceOptions)

Represents request frame that can be used with Network#loadNetworkResource operation call.

LoadNetworkResourceResponse

data class LoadNetworkResourceResponse(resource: LoadNetworkResourcePageResult)

Represents response frame that is returned from Network#loadNetworkResource operation call.

MonotonicTime

typealias MonotonicTime = Double

Monotonically increasing time in seconds since an arbitrary point in the past.

NetworkDomain

class NetworkDomain : Domain

Network domain allows tracking network activities of the page.

PostDataEntry

data class PostDataEntry(bytes: String?)

Post data entry for HTTP request

PrivateNetworkRequestPolicy

enum PrivateNetworkRequestPolicy : Enum<PrivateNetworkRequestPolicy>

ReplayXHRRequest

data class ReplayXHRRequest(requestId: RequestId)

Represents request frame that can be used with Network#replayXHR operation call.

Request

data class Request(url: String, urlFragment: String?, method: String, headers: Headers, postData: String?, hasPostData: Boolean?, postDataEntries: List<PostDataEntry>?, mixedContentType: MixedContentType?, initialPriority: ResourcePriority, referrerPolicy: String, isLinkPreload: Boolean?, trustTokenParams: TrustTokenParams?)

HTTP request data.

RequestId

typealias RequestId = String

Unique request identifier.

RequestInterceptedEvent

data class RequestInterceptedEvent(interceptionId: InterceptionId, request: Request, frameId: FrameId, resourceType: ResourceType, isNavigationRequest: Boolean, isDownload: Boolean?, redirectUrl: String?, authChallenge: AuthChallenge?, responseErrorReason: ErrorReason?, responseStatusCode: Int?, responseHeaders: Headers?, requestId: RequestId?) : Event

Details of an intercepted HTTP request, which must be either allowed, blocked, modified or mocked.

RequestPattern

data class RequestPattern(urlPattern: String?, resourceType: ResourceType?, interceptionStage: InterceptionStage?)

Request pattern for interception.

RequestServedFromCacheEvent

data class RequestServedFromCacheEvent(requestId: RequestId) : Event

Fired if request ended up loading from cache.

RequestWillBeSentEvent

data class RequestWillBeSentEvent(requestId: RequestId, loaderId: LoaderId, documentURL: String, request: Request, timestamp: MonotonicTime, wallTime: TimeSinceEpoch, initiator: Initiator, redirectResponse: Response?, type: ResourceType?, frameId: FrameId?, hasUserGesture: Boolean?) : Event

Fired when page is about to send HTTP request.

RequestWillBeSentExtraInfoEvent

data class RequestWillBeSentExtraInfoEvent(requestId: RequestId, associatedCookies: List<BlockedCookieWithReason>, headers: Headers, clientSecurityState: ClientSecurityState?) : Event

Fired when additional information about a requestWillBeSent event is available from the network stack.

ResourceChangedPriorityEvent

data class ResourceChangedPriorityEvent(requestId: RequestId, newPriority: ResourcePriority, timestamp: MonotonicTime) : Event

Fired when resource loading priority is changed

ResourcePriority

enum ResourcePriority : Enum<ResourcePriority>

Loading priority of a resource request.

ResourceTiming

data class ResourceTiming(requestTime: Double, proxyStart: Double, proxyEnd: Double, dnsStart: Double, dnsEnd: Double, connectStart: Double, connectEnd: Double, sslStart: Double, sslEnd: Double, workerStart: Double, workerReady: Double, workerFetchStart: Double, workerRespondWithSettled: Double, sendStart: Double, sendEnd: Double, pushStart: Double, pushEnd: Double, receiveHeadersEnd: Double)

Timing information for the request.

ResourceType

enum ResourceType : Enum<ResourceType>

Resource type as it was perceived by the rendering engine.

Response

data class Response(url: String, status: Int, statusText: String, headers: Headers, headersText: String?, mimeType: String, requestHeaders: Headers?, requestHeadersText: String?, connectionReused: Boolean, connectionId: Double, remoteIPAddress: String?, remotePort: Int?, fromDiskCache: Boolean?, fromServiceWorker: Boolean?, fromPrefetchCache: Boolean?, encodedDataLength: Double, timing: ResourceTiming?, serviceWorkerResponseSource: ServiceWorkerResponseSource?, responseTime: TimeSinceEpoch?, cacheStorageCacheName: String?, protocol: String?, securityState: SecurityState, securityDetails: SecurityDetails?)

HTTP response data.

ResponseReceivedEvent

data class ResponseReceivedEvent(requestId: RequestId, loaderId: LoaderId, timestamp: MonotonicTime, type: ResourceType, response: Response, frameId: FrameId?) : Event

Fired when HTTP response is available.

ResponseReceivedExtraInfoEvent

data class ResponseReceivedExtraInfoEvent(requestId: RequestId, blockedCookies: List<BlockedSetCookieWithReason>, headers: Headers, resourceIPAddressSpace: IPAddressSpace, headersText: String?) : Event

Fired when additional information about a responseReceived event is available from the network stack.

SearchInResponseBodyRequest

data class SearchInResponseBodyRequest(requestId: RequestId, query: String, caseSensitive: Boolean?, isRegex: Boolean?)

Represents request frame that can be used with Network#searchInResponseBody operation call.

SearchInResponseBodyResponse

data class SearchInResponseBodyResponse(result: List<SearchMatch>)

Represents response frame that is returned from Network#searchInResponseBody operation call.

SecurityDetails

data class SecurityDetails(protocol: String, keyExchange: String, keyExchangeGroup: String?, cipher: String, mac: String?, certificateId: CertificateId, subjectName: String, sanList: List<String>, issuer: String, validFrom: TimeSinceEpoch, validTo: TimeSinceEpoch, signedCertificateTimestampList: List<SignedCertificateTimestamp>, certificateTransparencyCompliance: CertificateTransparencyCompliance)

Security details about a request.

SecurityIsolationStatus

data class SecurityIsolationStatus(coop: CrossOriginOpenerPolicyStatus?, coep: CrossOriginEmbedderPolicyStatus?)

ServiceWorkerResponseSource

enum ServiceWorkerResponseSource : Enum<ServiceWorkerResponseSource>

Source of serviceworker response.

SetAttachDebugStackRequest

data class SetAttachDebugStackRequest(enabled: Boolean)

Represents request frame that can be used with Network#setAttachDebugStack operation call.

SetBlockedURLsRequest

data class SetBlockedURLsRequest(urls: List<String>)

Represents request frame that can be used with Network#setBlockedURLs operation call.

SetBypassServiceWorkerRequest

data class SetBypassServiceWorkerRequest(bypass: Boolean)

Represents request frame that can be used with Network#setBypassServiceWorker operation call.

SetCacheDisabledRequest

data class SetCacheDisabledRequest(cacheDisabled: Boolean)

Represents request frame that can be used with Network#setCacheDisabled operation call.

SetCookieBlockedReason

enum SetCookieBlockedReason : Enum<SetCookieBlockedReason>

Types of reasons why a cookie may not be stored from a response.

SetCookieRequest

data class SetCookieRequest(name: String, value: String, url: String?, domain: String?, path: String?, secure: Boolean?, httpOnly: Boolean?, sameSite: CookieSameSite?, expires: TimeSinceEpoch?, priority: CookiePriority?, sameParty: Boolean?, sourceScheme: CookieSourceScheme?, sourcePort: Int?)

Represents request frame that can be used with Network#setCookie operation call.

SetCookieResponse

data class SetCookieResponse(success: Boolean)

Represents response frame that is returned from Network#setCookie operation call.

SetCookiesRequest

data class SetCookiesRequest(cookies: List<CookieParam>)

Represents request frame that can be used with Network#setCookies operation call.

SetDataSizeLimitsForTestRequest

data class SetDataSizeLimitsForTestRequest(maxTotalSize: Int, maxResourceSize: Int)

Represents request frame that can be used with Network#setDataSizeLimitsForTest operation call.

SetExtraHTTPHeadersRequest

data class SetExtraHTTPHeadersRequest(headers: Headers)

Represents request frame that can be used with Network#setExtraHTTPHeaders operation call.

SetRequestInterceptionRequest

data class SetRequestInterceptionRequest(patterns: List<RequestPattern>)

Represents request frame that can be used with Network#setRequestInterception operation call.

SetUserAgentOverrideRequest

data class SetUserAgentOverrideRequest(userAgent: String, acceptLanguage: String?, platform: String?, userAgentMetadata: UserAgentMetadata?)

Represents request frame that can be used with Network#setUserAgentOverride operation call.

SignedCertificateTimestamp

data class SignedCertificateTimestamp(status: String, origin: String, logDescription: String, logId: String, timestamp: TimeSinceEpoch, hashAlgorithm: String, signatureAlgorithm: String, signatureData: String)

Details of a signed certificate timestamp (SCT).

SignedExchangeError

data class SignedExchangeError(message: String, signatureIndex: Int?, errorField: SignedExchangeErrorField?)

Information about a signed exchange response.

SignedExchangeErrorField

enum SignedExchangeErrorField : Enum<SignedExchangeErrorField>

Field type for a signed exchange related error.

SignedExchangeHeader

data class SignedExchangeHeader(requestUrl: String, responseCode: Int, responseHeaders: Headers, signatures: List<SignedExchangeSignature>, headerIntegrity: String)

Information about a signed exchange header.

SignedExchangeInfo

data class SignedExchangeInfo(outerResponse: Response, header: SignedExchangeHeader?, securityDetails: SecurityDetails?, errors: List<SignedExchangeError>?)

Information about a signed exchange response.

SignedExchangeReceivedEvent

data class SignedExchangeReceivedEvent(requestId: RequestId, info: SignedExchangeInfo) : Event

Fired when a signed exchange was received over the network

SignedExchangeSignature

data class SignedExchangeSignature(label: String, signature: String, integrity: String, certUrl: String?, certSha256: String?, validityUrl: String, date: Int, expires: Int, certificates: List<String>?)

Information about a signed exchange signature.

TakeResponseBodyForInterceptionAsStreamRequest

data class TakeResponseBodyForInterceptionAsStreamRequest(interceptionId: InterceptionId)

Represents request frame that can be used with Network#takeResponseBodyForInterceptionAsStream operation call.

TakeResponseBodyForInterceptionAsStreamResponse

data class TakeResponseBodyForInterceptionAsStreamResponse(stream: StreamHandle)

Represents response frame that is returned from Network#takeResponseBodyForInterceptionAsStream operation call.

TimeSinceEpoch

typealias TimeSinceEpoch = Double

UTC time in seconds, counted from January 1, 1970.

TrustTokenOperationDoneEvent

data class TrustTokenOperationDoneEvent(status: String, type: TrustTokenOperationType, requestId: RequestId, topLevelOrigin: String?, issuerOrigin: String?, issuedTokenCount: Int?) : Event

Fired exactly once for each Trust Token operation.

TrustTokenOperationType

enum TrustTokenOperationType : Enum<TrustTokenOperationType>

TrustTokenParams

data class TrustTokenParams(type: TrustTokenOperationType, refreshPolicy: String, issuers: List<String>?)

Determines what type of Trust Token operation is executed and depending on the type, some additional parameters.

WebSocketClosedEvent

data class WebSocketClosedEvent(requestId: RequestId, timestamp: MonotonicTime) : Event

Fired when WebSocket is closed.

WebSocketCreatedEvent

data class WebSocketCreatedEvent(requestId: RequestId, url: String, initiator: Initiator?) : Event

Fired upon WebSocket creation.

WebSocketFrame

data class WebSocketFrame(opcode: Double, mask: Boolean, payloadData: String)

WebSocket message data.

WebSocketFrameErrorEvent

data class WebSocketFrameErrorEvent(requestId: RequestId, timestamp: MonotonicTime, errorMessage: String) : Event

Fired when WebSocket message error occurs.

WebSocketFrameReceivedEvent

data class WebSocketFrameReceivedEvent(requestId: RequestId, timestamp: MonotonicTime, response: WebSocketFrame) : Event

Fired when WebSocket message is received.

WebSocketFrameSentEvent

data class WebSocketFrameSentEvent(requestId: RequestId, timestamp: MonotonicTime, response: WebSocketFrame) : Event

Fired when WebSocket message is sent.

WebSocketHandshakeResponseReceivedEvent

data class WebSocketHandshakeResponseReceivedEvent(requestId: RequestId, timestamp: MonotonicTime, response: WebSocketResponse) : Event

Fired when WebSocket handshake response becomes available.

WebSocketRequest

data class WebSocketRequest(headers: Headers)

WebSocket request data.

WebSocketResponse

data class WebSocketResponse(status: Int, statusText: String, headers: Headers, headersText: String?, requestHeaders: Headers?, requestHeadersText: String?)

WebSocket response data.

WebSocketWillSendHandshakeRequestEvent

data class WebSocketWillSendHandshakeRequestEvent(requestId: RequestId, timestamp: MonotonicTime, wallTime: TimeSinceEpoch, request: WebSocketRequest) : Event

Fired when WebSocket is about to initiate handshake.

WebTransportClosedEvent

data class WebTransportClosedEvent(transportId: RequestId, timestamp: MonotonicTime) : Event

Fired when WebTransport is disposed.

WebTransportConnectionEstablishedEvent

data class WebTransportConnectionEstablishedEvent(transportId: RequestId, timestamp: MonotonicTime) : Event

Fired when WebTransport handshake is finished.

WebTransportCreatedEvent

data class WebTransportCreatedEvent(transportId: RequestId, url: String, timestamp: MonotonicTime, initiator: Initiator?) : Event

Fired upon WebTransport creation.